home *** CD-ROM | disk | FTP | other *** search
/ United Public Domain Gold 4 / United Public Domain Gold 4.iso / fredfish / ff.0761.dms / ff.0761.adf / AztecErr / AztecErr.dok < prev    next >
Text File  |  1992-11-21  |  10KB  |  288 lines
  1.  
  2.  
  3.                                Dokumentation zu
  4.  
  5.                      AztecErr Version 1.0 © 1992 von H.P.G
  6.  
  7.                                    FreeWare
  8.  
  9. Index:
  10.  
  11.         Index
  12.         Allgemeine Beschreibung
  13.         System Vorraussetzungen
  14.         Rechtliches
  15.         Installation
  16.         Kommandozeile
  17.         Benutzung
  18.         Arexx-Kommandos
  19.         Technisches
  20.         BUGS
  21.         Zum Schluß
  22.         Liste der Dateien
  23.  
  24.  
  25.  
  26. Allgemeine Beschreibung:
  27.  
  28.  
  29.     Bei AztecErr handelt es sich um ein Programmier-Tool.
  30.     Es unterstützt die Quickfix-Option des Manx Aztec C Compilers Version
  31.     5.xx. Es besitzt ein GadTools-Benutzer-Interface.
  32.  
  33.     AztecErr ist ein OS 2.xx Tool und läuft leider unter  Kickstart  1.3
  34.     nicht.
  35.  
  36.     AztecErr [AE] liest die AztecC.Err Datei und zeigt den ersten  darin
  37.     enthaltenen Fehler an.
  38.     AE öffnet ein Fenster, auf dem sich mehrere Gadgets befinden.
  39.     Durch sie kann man zum  nächsten,  vorherigen,  ersten  oder  letzen
  40.     Fehler weiter gehen.
  41.     Für jedes dieser Gadgets existiert auch eine Taste,  die  man  wahl-
  42.     weise drücken kann.
  43.  
  44.     AztecErr unterstützt ENV-Variablen. D.h. AE setzt zwei Variablen auf
  45.     die in der AztecC.Err Datei enthaltenen  Werte.  Diese  ENV-Varablen
  46.     kann man dann später auswerten und z.B.  in  eienem  Editor  zu  der
  47.     Stelle des Fehlers in der Quell-Datei springen. Näheres siehe weiter
  48.     unten.
  49.  
  50.     Besitzt man die RexxHost.Library so öffnet AE einen RexxPort. So kann
  51.     man durch eine REXX Message die gleichen  Funktionen  bedienen,  wie
  52.     durch Betätigen der Gadgets.
  53.  
  54. System Vorraussetzungen:
  55.  
  56.     Man benötigt mindestens Kickstart 2.xx. Versionen 36L  laufen  wahr-
  57.     scheinlich auch nicht, da darin einige Funktionen noch nicht  imple-
  58.     mentiert waren.
  59.  
  60.     Außerdem ist AztecErr nur dann von  Nutzen,  wenn  man  das  AztecC-
  61.     CompilerSystem Version 5.xx installiert hat.
  62.  
  63.     Um AztecErr automatisch nutzen zu können muß man außerdem die  Umge-
  64.     bungsvariable CCEDIT mit dem Programm MSet (von Aztec) gesetzt haben
  65.     und beim Kompilieren die -qf Option benutzen.
  66.  
  67.     Keine Vorraussetzung, aber eine Empfehlung:
  68.     ===========================================
  69.     Benutzt man einen Editor, der über  einen  AREXX-Port  verfügt,  und
  70.     noch besser: außerdem über Macro-Funktionen, ( z.Bsp. DMe, Ced, etc.),
  71.     so kann man AE automatisch bedienen. Z.Bsp. indem man ein Arexx Script
  72.     entwirft,  daß   die   Umgebungsvariablen   'AztecErrLastLine'   und
  73.     'AztecErrLastColumn' einliest, und dann zu den angegebenen Punkten im
  74.     Text springt.
  75.     Ruft man dieses Script nach dem Compilieren auf, so kann man automa-
  76.     tisch die aufgetretenen Fehler beseitigen und nach dem letzten Fehler
  77.     erneut Kompilieren.
  78.     Ein entsprechendes Script für den DMe Editor habe ich beigelegt.
  79.  
  80.     Achtung: Dies alles funktioniert nur wenn man die  RexxHost.Library,
  81.              wie oben beschrieben vorher göffnet hat.
  82.  
  83. Rechtliches:
  84.  
  85.  
  86.         Ich habe mich entschlossen dieses Programm und alle beigefügten
  87.         Dateien und Scripts, sowie aller Anleitungen, als FREEWARE   zu
  88.         deklarieren.
  89.  
  90.         D.h.:
  91.  
  92.             Jeder kann AztecErr benutzen.
  93.             Jeder darf AztecErr weitergeben, wenn:
  94.  
  95.                 1. Alle unten aufgeführten Programme mit  weitergegeben
  96.                    werden,
  97.  
  98.                 2. Keinerlei Veränderungen der unten aufgeführten  Pro-
  99.                    grammen (am Ende der Anleitung)  vorgenommen wurden,
  100.  
  101.                 3. Bei  Nachkompilierungen  der QuellCodes muß ein Hin-
  102.                    weis  auf  den  Orginalprogrammierer beigefügt sein,
  103.                    bei  Herausgabe  dieser,  muß  eine  Kopie  an  mich
  104.                    gesandt werden.
  105.  
  106.                 4. AztecErr darf nicht verkauft werden.
  107.  
  108.                        Außnahme: Es darf eine geringe  Kopiergebühr er-
  109.                                  hoben werden, die aber  5 DM  bzw. den
  110.                                  entsprechenden  Gegenwert  in  anderen
  111.                                  Währungen nicht übersteigt.
  112.  
  113.                 5. AztecErr darf nur als Teil eines kommerziellen Produktes
  114.                    herrausgegeben  werden,  mit ausdrücklicher schrift-
  115.                    licher Genehmigung des Autors (Adresse siehe unten).
  116.  
  117.                 Zuwiderhandlungen  der  oben  Aufgeführten  Konditionen
  118.                 werden Zivilrechtlich verfolgt.
  119.  
  120.  
  121.         Ferner  wird  für  die Funktion des Programmes ,sowie möglicher
  122.         Folgen  der  Benutzung  des Programmes sowie der u. a. Dateien,
  123.         keinerlei Gewährleistung übernommen.
  124.  
  125.         !!! Alle Risiken trägt der Benutzer allein !!!
  126.  
  127.  
  128.  
  129. Installation:
  130.  
  131.     Am besten ist es, wenn man AztecErr in das hgleiche Verzeichnis kopiert,
  132.     indem sich auch cc, as und ln befinden. Es muß sich jedoch im aktuellen
  133.     AmigaDOS-Suchpfad befinden.
  134.  
  135.  
  136. Kommandozeile:
  137.  
  138.     AE unterstützt zur Zeit nur drei Parameter, welche optional sind:
  139.  
  140.     TopEdge/N   Das ist die obere Kante an der AE sein window öffnen soll.
  141.                 Voreinstellung ist 0.
  142.  
  143.     PortName    Das ist der Name des AREXX-Ports, den AE öffnen soll.
  144.                 Voreinstellung ist AZTEC_ERROR_PORT.
  145.  
  146.     Screen=S/K  Will man, daß AE auf einem anderen Screen erscheint, als
  147.                 der Workbench, kann man hier den Namen eines PublicScreens
  148.                 angeben.
  149.                 Achtung: Beim Namen des Screens wird zwischen Klein- und
  150.                 Großschreibung unterschieden.
  151.  
  152.  
  153. Benutzung:
  154.  
  155.     AE unterstützt die Quickfix-Option des Manx Aztec C  Compilers  Ver-
  156.     sion 5.xx. Wird beim Compilieren die Quickfix  Option  benutzt   und
  157.     findet der Compiler einen Fehler, wird das in  der  Umgebungsvariab-
  158.     len CCEDIT angegebene Programm gestartet.
  159.     Gibt man als CCEDIT AztecErr [OPTINEN] an, so wird AztecErr  gestar-
  160.     tet. AztecErr [AE] liest dann die Datei 'AztecC.Err'  im  momentanen
  161.     Verzeichnis und öffnet ein Fenster.
  162.     Beendet man AztecError, startet der Kompiler erneut.
  163.     Wird AztecErr mit dem Break  Gadgets  beendet,  setzt  AztecErr  den
  164.     Return Code auf WARN, was in Batch-Dateien  abgefragt  werden  kann.
  165.  
  166.     In der zweiten Gadgets-Reihe von oben erscheint dann der erste  auf-
  167.     getretene Fehler.
  168.  
  169.     Von links nach rechts erscheinen folgende Gadgets:
  170.  
  171.     Unter Err:          Das ist der momentan angezeigte Fehler
  172.     Unter Sum:          Das ist die Anzahl aller Fehler
  173.     Unter Kind:         Das ist die Art des Fehlers, entweder Fehler oder
  174.                         Warnung
  175.     Unter SourceFile    Das ist der Name des SourceFiles, indem die
  176.                         Fehler aufgetreten sind.
  177.     Ln:                 Die Zeilennummer des Fehlers
  178.     Col:                Die Spaltennummer des Fehlers
  179.     EC:                 Der Code des Fehlers
  180.  
  181.     Darunter            Hier wird die Ursache des Fehlers angegeben
  182.  
  183.     Nächste Zeile:
  184.  
  185.     First         [f]   Wird das Gadget betätigt oder die f Taste gedrückt,
  186.                         so zeigt AE den ersten Fehler an.
  187.     Previous      [p]   AE zeigt den vorhergehenden Fehler an
  188.     Next          [n]   AE zeigt den nächsten Fehler an. Ist bereits der
  189.                         letzte Fehler angezeigt, erscheint folgender Text
  190.                         ----- No More Errors ------.
  191.                         Wird danach Next noch einmal betätigt, schließt AE
  192.                         sein Fenster und beendet das Programm.
  193.     Last          [l]   AE zeigt den letzten Fehler an.
  194.     Quit          [q]   AE wird beendet.
  195.     Break         [b]   AE wird beendet mit Return-Code 5 (WARN).
  196.  
  197.     Zusätzlich kann man folgende Tasten drücken:
  198.  
  199.     [i]                 Ist dasselbe, als ob man das ZoomGadget betätigt.
  200.                         AE geht  in  seinen  Iconify-ten  Zustand  über.
  201.                         ACHTUNG: alle Funktionen sind auch in diesem Zu-
  202.                                  stand erreichbar.
  203.                         Durch erneutes drücken von 'i' erscheint das Fen-
  204.                         ster wieder in vorheriger Größe und am vorherigen
  205.                         Platz.
  206.  
  207. Arexx-Kommandos:
  208.  
  209.     Die Kommandos entsprechen den gleichnamigen Gadget Tasten.
  210.  
  211.     FIRST
  212.     PREVIOUS
  213.     NEXT
  214.     LAST
  215.     BREAK
  216.  
  217.     QUIT          CANCEL ist ein Synonym für QUIT und aus Sprachkompa-
  218.     CANCEL        tibelisationsgründen vorhanden.
  219.     EXIT
  220.  
  221.  
  222. Technisches:
  223.  
  224.     AE benutzt fast ausschließlich OS 2.xx Funktionen.
  225.     Dabei werden Funktionen der DOS,  Intuition  und  GadTools-Libraries
  226.     verwendet.
  227.  
  228.     Aus Gründen der Größe des Programmes habe ich auf übertriebene  Feh-
  229.     lerbehandelungen und Vorsichtsabfragen verzichtet.
  230.     Man sollte daher aufpassen, daß man nicht versucht AE  ein  falsches
  231.     AztecC.Err vorzugaukeln. Wenn das Format dieses Files nicht mit  den
  232.     orginalen Konzeptionen übereinstimmt, kann sich AE 'aufhängen'.
  233.     Auch sollte man nicht versuchen AE über ^C abzubrechen, da ich  auch
  234.     aus  Platzgründen  auf  Break-Handling-Routinen   verzichtet   habe.
  235.  
  236.     Besitzt man die RexxHost.Library nicht, so funktioniert AE  genauso,
  237.     nur mit der Einschränkung, daß kein AREXX-Port geöffnet wird. Und die
  238.     ENV Variablen AztecErrLastLine und AztecErrLastColumn nicht  gesetzt
  239.     werden.
  240.  
  241.     Man kann AE auch mit den Kommando 'rxsend' der Csh-Shell steuern. Man
  242.     braucht also keinen Editor, der über einen  Arexx-Port  verfügt,  es
  243.     reicht wenn er, wie z.Bsp.  MEmacs  über  die  Möglichkeit  verfügt,
  244.     DOS-Kommandos auszuführen. Dies ist allerdings entwas umständlicher.
  245.  
  246. Zum Schluß:
  247.  
  248.     Ich hoffe, daß viele Leute durch AE schneller und leichter  program-
  249.     mieren können und weniger Fehler bei Programmen auftauchen.
  250.  
  251.     Stellen sich evtl. Fehler von AE heraus, so schreibt mir bitte.
  252.  
  253.     Ansonsten,
  254.  
  255.     noch viel Spaß ..
  256.  
  257.  
  258. Adresse:
  259.  
  260.    Hans-Peter Günther
  261.    Grüner Weg 5
  262.    D-3501 Fuldatal 2
  263.    B.R.D (Germnany)
  264.  
  265.  
  266. Liste der Dateien:
  267.  
  268. (Fehlt eine der folgenden Dateien, ist diese Veröffentlichung inkomplett)
  269.  
  270.     AztecErr                    : Das Programm
  271.     AztecErr.info
  272.     AztecErr.doc                : Englische Anleitung
  273.     AztecErr.doc.info
  274.     AztecErr.dok                : Deutsche Anleitung
  275.     AztecErr.dok.info
  276.     AztecC.Err                  : Beispiel Fehlerdatei
  277.  
  278.     rexx  (dir)                 : Rexx scripts
  279.         DME_AztecError.dme      : Script für DMe
  280.         DME_AztecError.dme.info
  281.         TTX_AztecError.ttx      : Script für TTX
  282.         TTX_AztecError.ttx.info
  283.     rexx.info
  284.  
  285.  
  286. ----ENDE
  287.  
  288.